<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Identi Engine Documentation - Tag Structure</title>

<link rel="stylesheet" href="../css/site.css" type="text/css" media="all" />
<link rel="stylesheet" href="../css/documentation.css" type="text/css" media="all" />
<link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
<link rel="shortcut icon" href="../images/logo16.png"/>

<link type="application/rss+xml" rel="alternate" title="Ident Engine (RSS)" href="http://identengine.com/Blog/syndication.axd?format=rss" />
<link type="application/atom+xml" rel="alternate" title="Ident Engine (ATOM)" href="http://identengine.com/Blog/syndication.axd?format=atom" />

</head>

<body>
	<div class="header">
		<div class="centered">
			<a href="http://identengine.com/"><h1><span>Ident Engine</span></h1></a>
			<h2 id="strapline"><span>A JavaScript library that retrieves and aggregates profiles from across the web</span> </h2>
		</div>
	</div>

	<div class="content">
		<div class="centered">
		<div class="floatclear" style="clear:both">
			<ul class="menu">
				<li><a href="../index.htm" class="firstItem">home</a></li>
				<li><a href="index.htm">documentation</a></li>
				<li><a href="../opentables/index.htm">api</a></li>
				<li><a href="http://identengine.com/blog/">blog</a></li>
				<li><a href="../about/index.htm" class="lastItem">about</a></li>
			</ul>
		</div>	

	
		<h1>Documentation - Data Structures</h1>
		
		
		<p>
		The Identi Engine uses a number of different structures to store data. 
		Listed below are are all the public structures for use in your code.
		</p>
		
			<ul>
				<li><a href="identities-structure.htm">Identity</a></li>
				<li><a href="profile-structure.htm">Profile</a></li>
				<li><a href="resume-structure.htm">Resume</a></li>
				<li><a href="entry-structure.htm">Entry</a></li>
				<li><a href="event-structure.htm">Event</a></li>
				<li><a href="xfn-structure.htm">XFN</a></li>
				<li><a href="tag-structure.htm">Tag</a></li>
			</ul>
		
		<h2>Navigating data structures</h2>
		
		<p>
		<b>Always check for a properties existence <br /></b>The parsers will often only return the structure needed to describe 
		the values it has found. You should always check that a property or 
		object exists in the structure before trying to retrieve it.
		</p>
		
		<p>
		<strong>Multiple values</strong><b><br /></b>Where the microformat specification allows a property to have 
		multiple values the property will always be an array even if only one value 
		exists.
		</p>
		
		<p>
		<strong>Property names</strong><br />The microformats naming conventions for properties encourages the use of 
		hyphens between words i.e. post-office-box. With JavaScript if the 
		property name contains hyphens you need to address the property as an 
		item of the property collection.<br /><br />Addressing the property as 
		below will not work
		</p>
		
		<pre>   hCard.adr[0].post-office-box</pre>
		
		<p>
		Addressing the property as an item of the property collection&nbsp; will work 
		as below</p>
		
		<pre>   hCard.adr[0][&#39;post-office-box&#39;]</pre>
		
		<p>
		The rules for <a href="http://microformats.org/wiki/json">formatting 
		microformats into JavaScript</a> objects (JSON) are documented on 
		the microformat wiki.
		</p>
		
		
		</div>
		</div>
		
		
   <div class="footer">
		<div class="centered">
			<p class="cc-license">
				<a rel="license" href="http://creativecommons.org/licenses/by/2.0/uk/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by/2.0/uk/80x15.png" /></a><br /><span xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://purl.org/dc/dcmitype/Text" property="dc:title" rel="dc:type">Identi Engine Documentation</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://www.glennjones.net/" property="cc:attributionName" rel="cc:attributionURL">Glenn Jones</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/2.0/uk/">Creative Commons Attribution 2.0 UK: England &amp; Wales License</a>.<br />Based on a work at <a xmlns:dc="http://purl.org/dc/elements/1.1/" href="http://identengine.com/" rel="dc:source">identengine.com</a>.
			</p>
			<p class="copyright">© Copyright Glenn Jones 2009. All Rights Reserved.</p>
		</div>
	</div>

		
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-3021774-6");
pageTracker._trackPageview();
} catch(err) {}</script>

	

</body>
</html>
